Azure Maps Time Zone Service (preview:1.0)

2025/08/14 • 6 deleted methods

Timezone_GetTimezoneByID (removed)
Description :  __Time Zone by Id__ **Applies to**: S0 and S1 pricing tiers. This API returns current, historical, and future time zone information for the specified IANA time zone ID.
Reference :  Link ¶

⚼ Request

GET:  /timezone/byId/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in "EN". Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
options:
{
Description: Alternatively, use alias "o". Options available for types of information returned in the result. ,
Required: False ,
}
string ,
timeStamp:
{
Description: Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API will use the machine time serving the request. ,
Format: date-time ,
Required: False ,
}
string ,
transitionsFrom:
{
Description: Alternatively, use alias "tf". The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions. ,
Format: date-time ,
Required: False ,
}
string ,
transitionsYears:
{
Description: Alternatively, use alias "ty". The number of years from "transitionsFrom" for which DST transitions are requested, only applies when "options" = all or "options" = transitions. ,
Required: False ,
}
integer ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The IANA time zone ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Version:
{
Description: Version property ,
Required: False ,
}
string ,
ReferenceUtcTimestamp:
{
Description: Reference Utc Timestamp property ,
Format: date-time ,
Required: False ,
}
string ,
TimeZones:
{
Description: TimeZoneById array ,
Required: False ,
}
[
{
Id:
{
Description: Id property ,
Required: False ,
}
string ,
Aliases:
{
Description: An array of time zone ID aliases. Only returned when [options]=*zoneinfo* or *all*. Note: may be null. ,
Required: False ,
}
[
string ,
]
,
Countries:
{
Description: An array of country/region records. Only returned when [options]=*zoneinfo* or *all*. ,
Required: False ,
}
[
{
Name:
{
Description: country/region Name ,
Required: False ,
}
string ,
Code:
{
Description: ISO-3166 2-letter country/region code for the country/region . ,
Required: False ,
}
string ,
}
,
]
,
Names:
{
Description: Timezone names object. ,
Required: False ,
}
{
ISO6391LanguageCode:
{
Description: The ISO 639-1 language code of the Names ,
Required: False ,
}
string ,
Generic:
{
Description: Generic Name ,
Required: False ,
}
string ,
Standard:
{
Description: Standard Name ,
Required: False ,
}
string ,
Daylight:
{
Description: Daylight Name ,
Required: False ,
}
string ,
}
,
ReferenceTime:
{
Description: Details in effect at the local time. ,
Required: False ,
}
{
Tag:
{
Description: Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect). ,
Required: False ,
}
string ,
StandardOffset:
{
Description: UTC offset in effect at the `ReferenceUTCTimestamp`. ,
Required: False ,
}
string ,
DaylightSavings:
{
Description: Time saving in minutes in effect at the `ReferenceUTCTimestamp`. ,
Required: False ,
}
string ,
WallTime:
{
Description: Current wall time at the given time zone as shown in the `Tag` property. ,
Required: False ,
}
string ,
PosixTzValidYear:
{
Description: The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year. ,
Required: False ,
}
integer ,
PosixTz:
{
Description: POSIX string used to set the time zone environment variable. ,
Required: False ,
}
string ,
}
,
RepresentativePoint:
{
Description: Representative point property ,
Required: False ,
}
{
Latitude:
{
Description: Latitude property ,
Required: False ,
}
number ,
Longitude:
{
Description: Longitude property ,
Required: False ,
}
number ,
}
,
TimeTransitions:
{
Description: Time zone DST transitions from [transitionsFrom] until timestamp + 1 year. ,
Required: False ,
}
[
{
Tag:
{
Description: Tag property ,
Required: False ,
}
string ,
StandardOffset:
{
Description: StandardOffset property ,
Required: False ,
}
string ,
DaylightSavings:
{
Description: DaylightSavings property ,
Required: False ,
}
string ,
UtcStart:
{
Description: Start date, start time for this transition period ,
Format: date-time ,
Required: False ,
}
string ,
UtcEnd:
{
Description: End date, end time for this transition period ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Timezone_GetTimezoneByCoordinates (removed)
Description :  __Time Zone by Coordinates__ **Applies to**: S0 and S1 pricing tiers. This API returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.
Reference :  Link ¶

⚼ Request

GET:  /timezone/byCoordinates/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in "EN". Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
options:
{
Description: Alternatively, use alias "o". Options available for types of information returned in the result. ,
Required: False ,
}
string ,
timeStamp:
{
Description: Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API will use the machine time serving the request. ,
Format: date-time ,
Required: False ,
}
string ,
transitionsFrom:
{
Description: Alternatively, use alias "tf". The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions. ,
Format: date-time ,
Required: False ,
}
string ,
transitionsYears:
{
Description: Alternatively, use alias "ty". The number of years from "transitionsFrom" for which DST transitions are requested, only applies when "options" = all or "options" = transitions. ,
Required: False ,
}
integer ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates of the point for which time zone information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679". ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Version:
{
Description: Version property ,
Required: False ,
}
string ,
ReferenceUtcTimestamp:
{
Description: Reference Utc Timestamp property ,
Format: date-time ,
Required: False ,
}
string ,
TimeZones:
{
Description: TimeZoneByCoordinates array ,
Required: False ,
}
[
{
Id:
{
Description: Id property ,
Required: False ,
}
string ,
Aliases:
{
Description: An array of time zone ID aliases.  Only returned when [options]=*zoneinfo* or *all*. Note: may be null. ,
Required: False ,
}
[
string ,
]
,
Countries:
{
Description: An array of country/region records. Only returned when [options]=*zoneinfo* or *all*. ,
Required: False ,
}
[
{
Name:
{
Description: country/region Name ,
Required: False ,
}
string ,
Code:
{
Description: ISO-3166 2-letter country/region code for the country/region . ,
Required: False ,
}
string ,
}
,
]
,
Names:
{
Description: Timezone names object. ,
Required: False ,
}
{
ISO6391LanguageCode:
{
Description: The ISO 639-1 language code of the Names ,
Required: False ,
}
string ,
Generic:
{
Description: Generic Name ,
Required: False ,
}
string ,
Standard:
{
Description: Standard Name ,
Required: False ,
}
string ,
Daylight:
{
Description: Daylight Name ,
Required: False ,
}
string ,
}
,
ReferenceTime:
{
Description: Details in effect at the local time. ,
Required: False ,
}
{
Tag:
{
Description: Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect). ,
Required: False ,
}
string ,
StandardOffset:
{
Description: UTC offset in effect at the `ReferenceUTCTimestamp`. ,
Required: False ,
}
string ,
DaylightSavings:
{
Description: Time saving in minutes in effect at the `ReferenceUTCTimestamp`. ,
Required: False ,
}
string ,
WallTime:
{
Description: Current wall time at the given time zone as shown in the `Tag` property. ,
Required: False ,
}
string ,
PosixTzValidYear:
{
Description: The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year. ,
Required: False ,
}
integer ,
PosixTz:
{
Description: POSIX string used to set the time zone environment variable. ,
Required: False ,
}
string ,
Sunrise:
{
Description: Sunrise at the given time zone as shown in the `Tag` property. ,
Required: False ,
}
string ,
Sunset:
{
Description: Sunset at the given time zone as shown in the `Tag` property. ,
Required: False ,
}
string ,
}
,
RepresentativePoint:
{
Description: Representative point property ,
Required: False ,
}
{
Latitude:
{
Description: Latitude property ,
Required: False ,
}
number ,
Longitude:
{
Description: Longitude property ,
Required: False ,
}
number ,
}
,
TimeTransitions:
{
Description: Time zone DST transitions from [transitionsFrom] until timestamp + 1 year. ,
Required: False ,
}
[
{
Tag:
{
Description: Tag property ,
Required: False ,
}
string ,
StandardOffset:
{
Description: StandardOffset property ,
Required: False ,
}
string ,
DaylightSavings:
{
Description: DaylightSavings property ,
Required: False ,
}
string ,
UtcStart:
{
Description: Start date, start time for this transition period ,
Format: date-time ,
Required: False ,
}
string ,
UtcEnd:
{
Description: End date, end time for this transition period ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Timezone_GetTimezoneEnumWindows (removed)
Description :  __Enumerate Windows Time Zones__ **Applies to**: S0 and S1 pricing tiers. This API returns a full list of Windows Time Zone IDs.
Reference :  Link ¶

⚼ Request

GET:  /timezone/enumWindows/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
WindowsId:
{
Description: Windows Id property ,
Required: False ,
}
string ,
Territory:
{
Description: Territory property ,
Required: False ,
}
string ,
IanaIds:
{
Description: IanaIds array ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Timezone_GetTimezoneEnumIANA (removed)
Description :  __Enumerate IANA Time Zones__ **Applies to**: S0 and S1 pricing tiers. This API returns a full list of IANA time zone IDs. Updates to the IANA service will be reflected in the system within one day.
Reference :  Link ¶

⚼ Request

GET:  /timezone/enumIana/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id property ,
Required: False ,
}
string ,
isAlias:
{
Description: IsAlias property ,
Required: False ,
}
boolean ,
aliasOf:
{
Description: AliasOf property ,
Required: False ,
}
string ,
hasZone1970Location:
{
Description: HasZone1970Location property ,
Required: False ,
}
boolean ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Timezone_GetTimezoneIANAVersion (removed)
Description :  __Time Zone IANA Version__ **Applies to**: S0 and S1 pricing tiers. This API returns the current IANA version number.
Reference :  Link ¶

⚼ Request

GET:  /timezone/ianaVersion/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
version:
{
Description: Version property ,
Required: False ,
}
string ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
Timezone_GetTimezoneWindowsToIANA (removed)
Description :  __Windows to IANA Time Zone__ **Applies to**: S0 and S1 pricing tiers. This API returns a corresponding IANA ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.
Reference :  Link ¶

⚼ Request

GET:  /timezone/windowsToIana/{format}
{
x-ms-client-id:
{
Description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance. ,
Required: False ,
}
string ,
subscription-key:
{
Description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication. ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 1.0 ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The Windows time zone ID. ,
Required: True ,
}
string ,
territory:
{
Description: Windows Time Zone territory code. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Id property ,
Required: False ,
}
string ,
isAlias:
{
Description: IsAlias property ,
Required: False ,
}
boolean ,
aliasOf:
{
Description: AliasOf property ,
Required: False ,
}
string ,
hasZone1970Location:
{
Description: HasZone1970Location property ,
Required: False ,
}
boolean ,
}

⚐ Response (400)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
$headers:
{
www-authenticate:
{
Description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired" ,
}
string ,
}
,
$schema:
{
Description: This response object is returned when an error occurs in the Azure Maps API. ,
}
{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (403)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (500)

{
error:
{
Description: This object is returned when an error occurs in the Azure Maps API. ,
Required: False ,
}
{
code:
{
Description: The ODataError code. ,
Required: False ,
}
string ,
message:
{
Description: If available, a human-readable description of the error. ,
Required: False ,
}
string ,
details:
{
Required: False ,
}
[
string ,
]
,
target:
{
Description: If available, the target causing the error. ,
Required: False ,
}
string ,
}
,
}